﻿//-----------------------------------------------------------------------
// <copyright file="FutureState.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Threading.Future
{
    /// <summary>
    /// Enumeration of the states a future object can be in.
    /// </summary>
    public enum FutureState
    {
        /// <summary>
        /// State for when the future object is in the process of being
        /// computed.
        /// </summary>
        Computing,

        /// <summary>
        /// State for when the future object's value has been successfully
        /// computed and set.
        /// </summary>
        Completed,

        /// <summary>
        /// State for when the future object's computation has been canceled.
        /// </summary>
        Canceled,

        /// <summary>
        /// State for when the future object's value computation resulted in an
        /// error.
        /// </summary>
        Error,

        /// <summary>
        /// Invalid state for the future object.
        /// </summary>
        None
    }
}
